eFAWATEERcom BANK API
Claim Amount Posting
URLs :
Description : This service allows the channel or Bank itself to amend account balance for blink vostro
Mulesoft Request:
Mandatory Headers: client_id, x-coorelation-id, Authorization
Optional Headers: client_secret, x-channel-id, x-client-trace-id, x-bank-id,x-sub-channel-id, x-user-id, x-debug-flag, x-customer-id
Request Body: application/json
| Field Name | Type | Length | Occurrence | Description |
|---|---|---|---|---|
| debitAmount | String | M | ||
| debitValueDate | String | M | ||
| creditValueDate | String | M | ||
| narratives | Array of Strings | |||
| debitTheirRef | String | |||
| creditTheirRef | String |
{
"debitAmount": "2.0",
"debitValueDate": "20230808",
"creditValueDate": "20230808",
"narratives": ["Test","Test2"],
"debitTheirRef": "test",
"creditTheirRef": "test"
}
Mulesoft Response:
Success Response: (200)
Response Body: application/json
| Field Name | Type | Length | Occurrence | Description | Validation |
|---|---|---|---|---|---|
| status | Object | M | |||
| success | Boolean | M | true false | ||
| code | String | 10 | M | Error Code | “0” incase of success or Error Code |
| arabicMessage | String | 200 | M | English message translated to Arabic | تمت العملية بنجاح in case of success or arabic translated error in case of known errors |
| englishMessage | String | 200 | M | Description about the processing | “The Operation has been Successfully Completed” Or error Description |
| End of status | |||||
| response | Object | O | Exists if success = true | ||
| ftNumber | String | M | |||
| End of response |
{
"status": {
"success": true,
"code": "200",
"arabicMessage": "تمت العملية بنجاح",
"englishMessage": "The Operation has been Successfully Completed"
},
"response": {
"ftNumber": "FT03043523"
}
}Sample Error Response:
Error codes :
400:
content-type: JSON
{
"status": {
"success": false,
"code": 400,
"reasonCode": "BadRequest",
"arabicMessage": "DATE EXCEEDS MAXIMUM FORWARD",
"englishMessage": "DATE EXCEEDS MAXIMUM FORWARD",
"errorCode": "",
"errorDescription": ""
}
}